vcProductNeedFeedMatch

vcProductNeedFeedMatch is created when product matcher matches a need and a feed with each other. vcProductNeedFeedMatch stores the properties of the mached need and feed, and controls the state of the match.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
MatchedFeed	vcProductFeed	R	Gets the properties of the matched feed. After a match has been disposed, the value is None.
MatchedNeed	vcProductNeed	R	Gets the properties of the matched need. After a match has been disposed, the value is None.
SelectedProcessFlowInfo	vcNextProcessFlowInfo	R	Gets the flow info that was selected in the Feed-Need matching process.
State	vcProductMatchState	R	Gets the state of the match.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
dispose	None	None	Disposes a completed or cancelled match, so that the product need and product feed objects can be reused for another match. See more Changes the state to Disposed and sets the values of matched need and matched feed to None. If dispose is called from within a state change event handler, disposing is delayed and will only be executed after all event handlers have been called. Dispose can only be called when the state is Finalized, Cancelled, or Disposed. If the State is already Disposed, dispose does nothing. Exceptions: TypeError: When match is not in cancelled or finalized state before disposing.
finalizeMatch	None	Optional Keyword[receivingNeed = vcProductNeed]	Sets the match state to Finalized. Normally, done by the need owner in vcProductNeed.OnMatched event handler. See more Parameters: Optional: receivingNeed (vcProductNeed): Can replace the MatchedNeed if a value is given.
setOnNeedOrFeedDead	None	Callable OR None function	Sets the callback function that is called when the value of either the matched need or the matched feed is set to None. See more Parameters: function (callable): The function to call when the event is triggered.
setOnStateChanged	None	Callable OR None function	Sets the callback function that is called when the state of the match changes. See more Parameters: function (callable): The function to call when the event is triggered.
tryCancelMatch	None	None	Attempt to cancel the match. A match cannot be cancelled after the match has been finalized.